home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr31 / qzip104.zip / QZIP.DOC < prev    next >
Text File  |  1993-06-04  |  24KB  |  499 lines
  1.  
  2.                             Qzip Version 1.04
  3.       Copyright (c) 1991 - 1993 by Michael Leavitt, All Rights Reserved
  4.  
  5.  
  6. Quick Command Reference:
  7. ─────────────────────────────────────────────────────────────────────────────
  8.  
  9.         Usage: QZIP [-options] [-b path] [-t mmddyy] zipfile list [-x list]
  10.  
  11. [-options]:
  12.         -a   add files to zipfile (default)
  13.         -c   add file comment, -z add zipfile comment
  14.         -d   delete listed entries from zipfile
  15.         -f   freshen, only add changed files
  16.         -i, -s, -0...9 compress i=implode, s=shrink, 0=min, 9=max
  17.         -m   move files into zipfile, delete originals
  18.         -n   don't try to compress pre-compressed files
  19.         -o   set zip date to date of newest entry
  20.         -p   store directory names in zipfile
  21.         -r   recurse, include files in subdirectories
  22.         -u   update, only add changed or new files
  23.         -v   use BIOS video
  24.         -x   exclude files listed from being added
  25.         -+   don't use EMS memory
  26.  
  27.         The option letters must be preceded by a minus sign; multiple
  28.         options can follow one minus sign, or each option can have a
  29.         minus sign in front of it.  Options are case sensitive. A detailed
  30.         description of the options can be found later in this document.
  31.  
  32. [-b path]:
  33.         -b   specify drive or directory for temporary files.  Temporary
  34.         files created during Qzip's operation will be placed in the location
  35.         you specify after the -b switch, or in the current directory if no
  36.         -b path is given.
  37.  
  38. [-t mmddyy]:
  39.         -t   don't include files earlier than this date.  If this option is
  40.         specified, only files newer than MMDDYY will be included in the
  41.         zipfile.
  42.  
  43. zipfile:
  44.         The name or pathname of the zipfile to create or modify.  The .ZIP
  45.         extension will automatically be added to this name if you do not
  46.         specify an extension.
  47.  
  48. list:
  49.         A list of files to add to the zipfile.  You may specify more than
  50.         one filename or pathname here, and DOS wildcard characters are fully
  51.         supported.
  52.  
  53. [-x list]:
  54.         -x   don't include any of these files in zipfile.  This is an optional
  55.         list of filenames or pathnames to exclude from being included in the
  56.         zipfile; DOS wildcard characters are fully supported.
  57.  
  58.  
  59. Program License Information:
  60. ─────────────────────────────────────────────────────────────────────────────
  61.         Qzip Version 1.04 is copyrighted commercial software.  You are
  62.         granted a limited license to use this program in conjunction with
  63.         Sparkware's 1st Reader, and in compliance with the usage restrictions
  64.         of 1st Reader.  You may not copy this program or its documentation for
  65.         any purpose other than backup purposes.  Distribution of this program
  66.         or its documentation to persons other than registered users of 1st
  67.         Reader is expressly prohibited.
  68.  
  69.         Michael Leavitt, the author of the Qzip code, and Sparkware hereby
  70.         disclaim all warranties relating to this software, whether expressed
  71.         or implied, including without limitation any implied warranties of
  72.         merchantability or fitness for a particular purpose.  Neither the
  73.         author nor Sparkware will be liable for any special, incidental,
  74.         consequential, indirect or similar damages due to loss of data or any
  75.         other reason, even if the author, Sparkware, or an agent of the author
  76.         or Sparkware has been advised of the possibility of such damages.
  77.  
  78.         In no event shall the author's or Sparkware's liability for any damages
  79.         ever exceed the price paid for the license to use the software,
  80.         regardless of the form of the claim.  The person using the software
  81.         bears all risk as to the quality and performance of the software.
  82.  
  83.  
  84. Program Description:
  85. ─────────────────────────────────────────────────────────────────────────────
  86.         Qzip can create, modify, and update ZIP files.  Zipfiles created by
  87.         Qzip can be extracted by Qunzip or any version of PKUNZIP greater than
  88.         1.00.  All PKZIP features are supported except encryption and AV
  89.         codes.
  90.  
  91.         For maximum compatibility, Qzip creates ZIP files in PKZIP 1.00
  92.         format.  This means that files created by Qzip can be unzipped by
  93.         any version of PKUNZIP thru version 2.04.  However, Qzip compresses
  94.         files even smaller than PKZIP 1.10, retaining full compatibility
  95.         with earlier versions of PKUNZIP while providing the benefits of
  96.         advanced compression.
  97.  
  98.         Qzip provides a colorful pop-up display that includes an animated
  99.         compression status display.  This allows Qzip to be run as a shell
  100.         process from another program and appear to be an integrated part
  101.         of that program.
  102.  
  103.         Qzip provides fast performance, but uses much less memory than PKZIP
  104.         when operating.  Qzip automatically detects if your system has EMS
  105.         (Expanded) memory, and makes use of it to reduce the amount of DOS
  106.         memory used and to increase operating speed.
  107.         On systems without EMS memory, Qzip needs at least 240K of free DOS
  108.         memory to run.  On systems that do have EMS memory, Qzip only needs
  109.         at least 205K of free DOS memory to operate.  This memory requirement
  110.         varies with the number of files being added to a zipfile, and
  111.         normally is less than the above figures.  Like Qunzip, Qzip is a
  112.         '32-bit clean' application and will run under Windows or OS/2 in
  113.         protected mode just as well as it runs under DOS.
  114.  
  115.  
  116. Examples:
  117. ─────────────────────────────────────────────────────────────────────────────
  118.         To use Qzip to add every file in the current directory to a zipfile
  119.         called MYFILE.ZIP:
  120.  
  121.                 QZIP myfile *.*
  122.  
  123.         To create a zipfile called MYFILE.ZIP that contains not just the
  124.         contents of the current directory, but also the contents of all
  125.         subdirectories under the current directory:
  126.  
  127.                 QZIP -r myfile *.*
  128.  
  129.         To create the same zipfile as the previous example, but also store
  130.         the subdirectory names so that when it is unzipped the subdirectories
  131.         can be recreated:
  132.  
  133.                 QZIP -rp myfile *.*
  134.  
  135.         If you're zipping to save disk space, you might want to delete the
  136.         source files after they've been included in the zipfile.  To create
  137.         MYFILE.ZIP containing the contents of the current directory, and
  138.         automatically delete the originals when the zipfile is built:
  139.  
  140.                 QZIP -m myfile *.*
  141.  
  142.  
  143.         When given the name of an existing zipfile with any of the above
  144.         commands, Qzip will update the zipfile, replacing identically named
  145.         entries and adding new entries for files that aren't already present
  146.         in the zipfile.
  147.  
  148.         Other options are available when updating a zipfile.  For example,
  149.         if you would like to update the contents of MYFILE.ZIP, replacing any
  150.         files in the zipfile with newer ones from the current directory and
  151.         adding entries for those which are not already stored in the zipfile:
  152.  
  153.                 QZIP -u myfile *.*
  154.  
  155.         Of if you'd like to 'freshen' MYFILE.ZIP with newer files from the
  156.         current directory - but not add any files to the zipfile that aren't
  157.         already present:
  158.  
  159.                 QZIP -f myfile *.*
  160.  
  161.  
  162.         Another restriction that can be used with adding, updating, or
  163.         freshening is -t (time), which will not operate on files modified
  164.         earlier than the specified date.  To add to MYFILE.ZIP only those
  165.         files that have a file date newer than 04/09/92:
  166.  
  167.                 QZIP -t 040992 myfile *.*
  168.  
  169.         You can exclude certain files from the zipfile when you create it
  170.         using wildcards.  If you'd like to create MYFILE.ZIP and include
  171.         everything in the current directory except EXE files:
  172.  
  173.                 QZIP myfile *.* -x *.exe
  174.  
  175.         And you can delete files from an already existing zipfile.  If you'd
  176.         like to remove OLDFILE.TXT from MYFILE.ZIP:
  177.  
  178.                 QZIP -d myfile oldfile.txt
  179.  
  180.  
  181. Compression Options:
  182. ─────────────────────────────────────────────────────────────────────────────
  183.         Qzip automatically selects the best compression method to use on a
  184.         file by file basis as it creates a zipfile.  In most cases, the
  185.         selection that Qzip makes is optimum - but there may be times when you
  186.         wish to override this selection.
  187.  
  188.         Qzip can use three different methods for packing your file: implode,
  189.         shrink, or store.  Usually, implode provides the best compression, but
  190.         sometimes shrink is better - especially for smaller files.  Sometimes,
  191.         neither implode nor shrink produces a packed version smaller than the
  192.         original file, in which case the file is stored in the zipfile with no
  193.         compression (store).
  194.  
  195.         Shrinking is faster than imploding, so if speed is more important to
  196.         you than compression efficiency the -s option can be used to force
  197.         Qzip to either shrink or store files.
  198.  
  199.         If you are compressing large files only (greater than 32K), then using
  200.         the -i option to force Qzip to implode or store files will be a little
  201.         bit faster than no option at all.
  202.  
  203.         Further control is provided over the speed of implosion with options
  204.         -0 (fastest, least compression) to -9 (slowest, best compression).
  205.         The default value is -5.
  206.  
  207.         In nearly all cases, a file that is already compressed can't be
  208.         compressed further by Qzip - or it it can, the effect is minimal.
  209.         By default, Qzip will attempt to compress all files you specify.  But
  210.         if you include the -n option on the command line, Qzip will simply
  211.         store all files ending in .ZIP, .ARC, .LZH, and .ARJ suffixes. This
  212.         avoids Qzip wasting its time trying to compress them again.  You can
  213.         override this default selection of extensions to avoid by setting the
  214.         NOZIP DOS environment variable.  If the NOZIP environment variable is
  215.         set, Qzip will use the extensions listed there as its list of file
  216.         types to not compress.  Extensions in the NOZIP environment variable
  217.         must be separated with semicolons.  For example:
  218.  
  219.                 SET NOZIP=.ZIP;.ARC;.ARJ;.LZH;.GIF;.TIF
  220.  
  221.         If the NOZIP environment variable exists but is empty, or contains
  222.         just a semicolon, QZIP -n will store all entries and do no compression
  223.         on any of them.
  224.  
  225.  
  226. Zipfile Comments:
  227. ─────────────────────────────────────────────────────────────────────────────
  228.         One line comments can be added for each file in the zipfile by using
  229.         the -c option.  The zip operations will be done first, then you will
  230.         be prompted for a one line comment for each file.  You can enter a
  231.         comment at this point, or just press enter for no comment.
  232.  
  233.         The -z option will prompt you for a multi-line comment for the entire
  234.         zipfile.  This option can be used by itself, or in combination with
  235.         other options.  After the zip operations are completed, you will be
  236.         presented with a full-screen entry area for your file comment.  End
  237.         your comment entry with a line containing just a period.  Also, you
  238.         can redirect a text file into the zipfile comment.  To add the
  239.         contents of COMMENT.TXT to MYFILE.ZIP:
  240.  
  241.                 QZIP -z myfile < comment.txt
  242.  
  243.  
  244. Detailed Description of Qzip Options:
  245. ─────────────────────────────────────────────────────────────────────────────
  246.  
  247. -0...9 implosion level.
  248.         These numeric options select the level of implosion to use in
  249.         compressing files.  See 'Compression Options' above for more
  250.         information.
  251.  
  252. -a   add files to zipfile (default)
  253.         This is Qzip's normal mode of operation.  This command has no effect,
  254.         but is provided for compatibility with programs that pass this option
  255.         by default.
  256.  
  257. -b   specify drive or directory for temporary files.
  258.         Temporary files are created during Qzip operation.  These files are
  259.         placed in the current directory by default, but you can have Qzip
  260.         build its temporary files in another location (like on a ramdrive) by
  261.         including the -b option and the directory where you want the temporary
  262.         files to be placed.  For example, QZIP -b \temp myfile *.* causes Qzip
  263.         to create MYFILE.ZIP containing everything in the current directory,
  264.         but create its temporary files in the \temp directory.
  265.  
  266. -c   add file comment
  267.         The -c option tells Qzip that you would like to add a one-line comment
  268.         to each file in the zipfile.  After the zip operations are complete,
  269.         Qzip will prompt you for comments for each file.  See 'Zipfile
  270.         Comments' above for more information.
  271.  
  272. -d   delete listed entries from zipfile
  273.         This option is only useful when updating an already existing zipfile.
  274.         It tells Qzip to delete from the zipfile all filenames following on
  275.         the command line.
  276.  
  277. -f   freshen, only add changed files
  278.         This option is only useful when updating an already existing zipfile.
  279.         When this option is in use, Qzip will 'freshen' the contents of the
  280.         zipfile.  Only filenames that already exist in the zipfile will be
  281.         replaced, and only if the source files are newer.  No new files will
  282.         be added to the zipfile.
  283.  
  284. -i   implode only
  285.         The -i option tells Qzip to implode or store only.  See 'Compression
  286.         Options' above for more information.
  287.  
  288. -m   move files into zipfile, delete originals
  289.         The -m option tells Qzip to 'move' the source files into the zipfile
  290.         and delete the originals when done.  Qzip will not delete the original
  291.         files until the zipfile has been completely built with no errors.
  292.  
  293. -n   don't try to compress pre-compressed files
  294.         This option tells Qzip to not bother trying to compress files that are
  295.         already compressed.  See 'Compression Options' above for more
  296.         information.
  297.  
  298. -o   set zip date to date of newest entry
  299.         By default, Qzip dates the zipfile with the date and time of its
  300.         creation.  If you'd like the time and date of the zipfile to reflect
  301.         the time and date of the newest file inside the zipfile instead, use
  302.         this option.
  303.  
  304. -p   store directory names in zipfile
  305.         By default, Qzip just stores the filenames of the files it packs into
  306.         a zipfile.  However, by using the -p option you can tell Qzip to
  307.         include the complete pathname of the file.  Files created using this
  308.         option can be unzipped using the -d option on Qunzip or PKUNZIP to
  309.         extract the files into the same subdirectories that they came from.
  310.  
  311. -r   recurse, include files in subdirectories
  312.         When you specify files to include in a zipfile using wildcards, Qzip
  313.         normally only includes files in the current directory or the directory
  314.         that you specify.  Adding the -r option tells Qzip to 'recurse'
  315.         through all subdirectories below the one you specify, including files
  316.         found there also.  For example, QZIP -r bigfile c:\*.* would create
  317.         BIGFILE.ZIP containing every file on drive c.
  318.  
  319. -s   shrink only
  320.         The -s option tells Qzip to shrink or store files only.  See
  321.         'Compression Options' above for more information.
  322.  
  323. -t   don't include files earlier than this date.
  324.         If this option is specified, only files newer than MMDDYY will be
  325.         included in the zipfile.  For example, QZIP -t 040992 myfile *.*
  326.         will create MYFILE.ZIP containing all files in the current directory
  327.         with dates newer than 04/09/92.
  328.  
  329. -u   update, only add changed or new files
  330.         This option is only useful when updating an already existing zipfile.
  331.         It tells Qzip to only 'update' the file; files already in the zipfile
  332.         will only be replaced if the source file is newer, and any source
  333.         files that don't already exist in the zipfile will be added.
  334.  
  335. -v   use BIOS video
  336.         Qzip produces its display using direct video memory access to
  337.         provide the greatest possible speed.  This method of updating the
  338.         screen is compatible with all 'IBM standard' display adapters and
  339.         you should have no need to use the -v option.  However, if your
  340.         display adapter is 'non-standard' and the Qzip display appears
  341.         scrambled or doesn't appear at all, adding the -v option to the
  342.         command line will cause Qzip to use the video BIOS routines built
  343.         into your machine to update the display.  This option is also useful
  344.         to eliminate screen 'snow' that may appear on old CGA displays while
  345.         the screen is being updated.
  346.  
  347. -z   add zipfile comment
  348.         This option can be used alone or in conjunction with other options
  349.         to cause a zipfile comment to be added to the zipfile.  See 'Zipfile
  350.         Comments' above for more information.
  351.  
  352. -x   don't include any of these files in zipfile.
  353.         This is an optional list of filenames or pathnames to exclude from
  354.         being included in the zipfile; DOS wildcard characters are fully
  355.         supported.  For example, QZIP myfile *.* -x *.exe will create
  356.         MYFILE.ZIP containing everything in the current directory except
  357.         files with the .EXE extension.
  358.  
  359. -+   don't use EMS memory.
  360.         Qzip automatically detects and makes use of EMS memory if your
  361.         system is so equipped.  If your system's EMS memory is malfunctioning,
  362.         the zipfiles created by Qzip may be corrupted.  Adding the -+ option
  363.         to the Qzip command line tells Qzip to not use EMS memory; this can
  364.         be used as a 'work around' for troublesome systems.
  365.  
  366. Qzip Error Messages:
  367. ─────────────────────────────────────────────────────────────────────────────
  368. Unexpected end of zip file:
  369.         While Qzip was reading the zipfile that it was updating, it reached
  370.         the end of the file before all necessary data was read.  The zipfile
  371.         is damaged.
  372.  
  373. Zip file structure invalid:
  374.         The zipfile that Qzip was trying to update is not a valid zipfile,
  375.         or is corrupt.
  376.  
  377. Out of memory:
  378.         There is not enough memory for Qzip to run.  Make sure you have
  379.         enough free DOS memory to run Qzip.
  380.  
  381. Internal logic error:
  382.         Qzip's internal self-checking has found an error.  You should never
  383.         encounter this error message - if you do, please report this error
  384.         to the author.
  385.  
  386. Invalid comment format:
  387.         The zip comment in the zipfile that Qzip is trying to update is
  388.         invalid.  This zipfile is most likely corrupt.
  389.  
  390. Temporary file failure:
  391.         Qzip creates temporary files when updating an existing zipfile.  It
  392.         was unable to do so because the disk is full, or the temporary
  393.         directory you specified with the -b option is invalid.  Also, if
  394.         your system's EMS memory is malfunctioning this error can result.
  395.         Adding the -+ option to the command line might help; see the
  396.         description of that option above.
  397.  
  398. Input file read failure:
  399.         Qzip was able to locate and start reading the input file, but an
  400.         error occured as it continued to read the file.  This error is most
  401.         likely to happen when another process is using this file on a network
  402.         or multi-tasker and SHARE is not loaded.
  403.  
  404. Nothing to do!:
  405.         You tried to add non-existent files to a zipfile, or the options
  406.         specified on the command line were invalid.
  407.  
  408. Missing or empty zip file:
  409.         The zipfile you are asking Qzip to update can't be located, or it
  410.         contains no files.
  411.  
  412. Output file write failure:
  413.         Qzip was unable to create the requested zipfile because the disk is
  414.         full.  Delete some unnecessary files and try again.
  415.  
  416. Could not create output file:
  417.         Qzip was unable to create the zipfile.  Either you tried to create
  418.         the zipfile in a non-existent subdirectory, a network directory
  419.         that you don't have access rights to, or the subdirectory where you
  420.         are trying to create the zipfile is full.
  421.  
  422. Invalid command arguments:
  423.         The command line parameters passed to Qzip are invalid or
  424.         contradictory.
  425.  
  426. File not found or no read permission:
  427.         The file that Qzip was trying to read either does not exist, is not
  428.         in the directory you specified, is locked by another process on a
  429.         network or multi-tasker, or is located in a network subdirectory that
  430.         you do not have access rights to.
  431.  
  432. Drive not ready:
  433.         DOS was unable to access the drive you specified; if this was a
  434.         floppy drive, check to make sure the disk is inserted.  If you
  435.         specified a hard drive, a serious hardware problem is indicated.
  436.  
  437.  
  438. Exit Codes:
  439. ─────────────────────────────────────────────────────────────────────────────
  440.         Qzip returns an exit code upon termination showing the status of
  441.         its operation.  These exit codes can be tested in batch files set
  442.         up for unattended operation to determine if the Qzip operation was
  443.         successful, and if not to indicate the cause of failure.  A list of
  444.         the possible exit codes and their meaning follows:
  445.  
  446. 0 (Success):
  447.         Qzip operation completed successfully; no errors detected.
  448.  
  449. 2 (Unexpected end of zip file):
  450.         End of file reached prematurely while reading the zipfile that
  451.         was being updated.  Zipfile is corrupt.
  452.  
  453. 3 (Zip file structure error):
  454.         Zipfile being updated has an invalid structure.  Zipfile is corrupt.
  455.  
  456. 4 (Out of memory):
  457.         There was insufficient free memory for Qzip to run.
  458.  
  459. 5 (Internal logic error):
  460.         An internal error occured while processing file.  Zipfile is corrupt.
  461.  
  462. 7 (Invalid comment format):
  463.         Zipfile being updated has an invalid zip comment.
  464.  
  465. 9 (User abort):
  466.         Control-Break was pressed to interrupt operation.
  467.  
  468. 10 (Temp file error):
  469.         An error occured while writing a temporary file; disk is full or an
  470.         EMS problem has been encountered.
  471.  
  472. 11 (Read error):
  473.         Unable to read input file.
  474.  
  475. 12 (Nothing to do):
  476.         Commands given do not accomplish anything.
  477.  
  478. 13 (Missing or empty zip file):
  479.         Zipfile to update is empty or can not be found.
  480.  
  481. 14 (Error writing to file):
  482.         An error occured while writing an output file; disk is full.
  483.  
  484. 15 (Error opening output file):
  485.         Unable to open or create the new zipfile.
  486.  
  487. 16 (Invalid command line parameters):
  488.         Command line options are invalid or contradictory.
  489.  
  490. 18 (Error opening input file):
  491.         Unable to open one of the files being added to the zipfile.
  492.  
  493.  
  494. Credits:
  495. ─────────────────────────────────────────────────────────────────────────────
  496.         PKUnzip and PKZip are trademarks of PKWARE Inc.
  497.         DOS and Windows are trademarks of Microsoft Corp.
  498.         IBM and OS/2 are trademarks of International Business Machines, Inc.
  499.